A watermark is a recognizable image or text pattern that appears superimposed on a generated PDF output. In the ExpereAPI, watermarks are implemented as a post-processing event submitted on a request in the AncillaryOutputOptions object and defined through a single object, Watermark, containing a string parameter to define the image URL for the watermark, a string parameter to define the text to include in the watermark, a boolean to set the rotation of the watermark on the page, and an object to define the location of the watermark.
Note: Watermarks are processed using iText programmable PDF software, not the Adobe PDF Watermark functionality.
A visual representation of the Watermark object looks like:
- ImageURL: The location (URL) of the image to processed as part of the watermark.
- Text: The text (copy) to include as the watermark text.
- Rotate: A boolean defining if the watermark should display as rotated (at a 45 degree angle) on the output page. A TRUE value indicates the watermark is rotated on the page; a FALSE value indicates it is not rotated.
- Location: Object defining the target location for a watermark (based on an enumerated value). Options include top, center, and bottom.